Platform Explorer / Nuxeo Platform 2023.22

Operation Document.GetContainerRendition (Gets the folder's children or the collection's members default renditions)

Description

Gets the list of blob of the folder's children or the collection's members default renditions. Returns a blob list file containing all the default rendition blobs.
Operation id Document.GetContainerRendition
Category Files
Label Gets the folder's children or the collection's members default renditions
Requires
Since

Parameters

Name Description Type Required Default value
limit Limit of members to be returned. Default is 100. int no  
maxDepth Depth of the hierarchy to be explored. Default is 1. int no  
reason string no  

Signature

Inputs document
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.rendition.operation.GetContainerRendition
Contributing Component org.nuxeo.ecm.platform.rendition.operations

JSON Definition

{
  "id" : "Document.GetContainerRendition",
  "label" : "Gets the folder's children or the collection's members default renditions",
  "category" : "Files",
  "requires" : null,
  "description" : "Gets the list of blob of the folder's children or the collection's members default renditions. Returns a blob list file containing all the default rendition blobs.",
  "url" : "Document.GetContainerRendition",
  "signature" : [ "document", "blob" ],
  "params" : [ {
    "name" : "limit",
    "description" : "Limit of members to be returned. Default is 100.",
    "type" : "int",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "maxDepth",
    "description" : "Depth of the hierarchy to be explored. Default is 1.",
    "type" : "int",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "reason",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}